SureTax Returns API
DELETE Form Instances
Overview
This API endpoint enables the deletion of generated form instances from the system. It provides clients with the ability to remove specific form instances that are no longer needed or relevant, helping to maintain data integrity and system cleanliness.
OperationId: DELETE Form Instances
Authorization Method(s): OAuth
Verb: DELETE
End Point: /api/v1/Forms/FormInstances
Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.
| Display String | Field Name | Field Type |
|---|---|---|
| Id* | Id | string |
Overview
Response object for DELETE requests that remove form instances, including error messages for any issues encountered during the deletion process.
Example Response
The following is an example response you can expect for this operation
{
"data": {
"formInstances": [
{
"id": "FORM12345",
"errorMessage": "No errors."
},
{
"id": "FORM67890",
"errorMessage": "Error while deleting form instance."
}
]
}
}
Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.
| code | description |
|---|---|
| 200 | The API response contains the status of the deleted form instances along with any error messages. |
| 400 | Bad request. Invalid data provided. |
| 401 | Unauthorized access. |
| 500 | Internal server error. |